Skip to main content

Create a Warehouse Receive

To create a new warehouse receive, you can make a POST request to the /warehouse/v1/receives endpoint. The JSON payload for this request should include at minimum the following fields: warehouseCode, primaryReference, and receiveLines.

The below request body includes the following:

  • warehouseCode: A string value representing the code of the warehouse where the receive will take place.
  • primaryReference: A string value representing a unique and immutable value in the upstream system.
  • secondaryReference: A string value which does not need to be unique and can be used to identify the inbound shipment.
  • transportReference: A string value which contains the PRO number, tracking number, or container number of the related shipment.
  • eta: An ISO 8601 formatted string representing the estimated time of arrival.
  • receiveLines: An array of objects representing the items being received, including the external line reference, product code, quantity, and quantity unit.
Example Request 
POST /warehouse/v1/receives HTTP/1.1
x-api-key: your_api_key
organization-slug: your_organization_slug (if required)
Content-Type: application/json

{
  "warehouseCode": "LAW",
  "primaryReference": "12345678",
  "secondaryReference": "PO00001234",
  "eta": "2023-05-01T10:00:00+00:00",
  "transportReference": "PRO123456",
  "shipFromAddress": {
    "address": {
      "organization": "ABC Distributors",
      "addressLine1": "123 Main Street",
      "addressLine2": "",
      "country": "USA",
      "state": "CA",
      "city": "Los Angeles",
      "postalCode": "90012"
    },
    "contact": {
      "personName": "John Doe",
      "phoneNumber": "123-456-7890",
      "mobileNumber": "",
      "faxNumber": "",
      "emailAddress": "john.doe@abcdistributors.com"
    }
  },
  "receiveLines": [
    {
      "externalLineReference": "001",
      "productCode": "APL-IPH-13PRO-256-GRPH",
      "quantity": 100,
      "quantityUnit": "UNT"
    },
    {
      "externalLineReference": "002",
      "productCode": "SAM-GS22ULTRA-SILCASE-BLK",
      "quantity": 50,
      "quantityUnit": "UNT"
    },
    {
      "externalLineReference": "003",
      "productCode": "HP-SPX360-14-OLED-I7-16GB-1TB-NFBLK",
      "quantity": 25,
      "quantityUnit": "UNT"
    }
  ],
  "additionalReferences": [
    {
      "key": "INV",
      "value": "INV12345"
    }
  ]
}

Replace your_api_key with your actual API key and your_organization_slug with your organization slug, if required.

If the request is successful, you will receive a 200 OK status code and a JSON response containing the newly created warehouse receive.

Example Response
{
    "data": {
        "id": "6434b6ccdd3283f909d1b990",
        "dateCreated": "2023-04-11T01:24:28+00:00",
        "dateLastUpdated": "2023-04-11T01:24:28+00:00",
        "warehouseCode": "LAW",
        "primaryReference": "12345678",
        "secondaryReference": "PO00001234",
        "status": "PRS",
        "eta": "2023-05-01T10:00:00+00:00",
        "transportReference": "PRO123456",
        "shipFromAddress": {
            "address": {
                "organization": "ABC Distributors",
                "addressLine1": "123 Main Street",
                "addressLine2": "",
                "country": "USA",
                "state": "CA",
                "city": "Los Angeles",
                "postalCode": "90012",
                "isResidential": false
            },
            "contact": {
                "personName": "John Doe",
                "phoneNumber": "123-456-7890",
                "mobileNumber": "",
                "faxNumber": "",
                "emailAddress": "john.doe@abcdistributors.com"
            }
        },
        "receiveLines": [
            {
                "lineNumber": "1",
                "externalLineReference": "001",
                "productCode": "APL-IPH-13PRO-256-GRPH",
                "quantity": 100,
                "quantityUnit": "UNT",
                "lineAttributes": [],
                "lineCustomAttributes": [],
                "partAttributes": []
            },
            {
                "lineNumber": "2",
                "externalLineReference": "002",
                "productCode": "SAM-GS22ULTRA-SILCASE-BLK",
                "quantity": 50,
                "quantityUnit": "UNT",
                "lineAttributes": [],
                "lineCustomAttributes": [],
                "partAttributes": []
            },
            {
                "lineNumber": "3",
                "externalLineReference": "003",
                "productCode": "HP-SPX360-14-OLED-I7-16GB-1TB-NFBLK",
                "quantity": 25,
                "quantityUnit": "UNT",
                "lineAttributes": [],
                "lineCustomAttributes": [],
                "partAttributes": []
            }
        ],
        "additionalReferences": [
            {
                "key": "INV",
                "value": "INV12345"
            }
        ],
        "shipments": [
            {
                "id": "6434b6cfdd3283f909d1b991",
                "dateCreated": "2023-04-11T01:24:31+00:00",
                "dateLastUpdated": "2023-04-11T01:24:31+00:00",
                "warehouseCode": "LAW",
                "primaryReference": "12345678",
                "secondaryReference": "PO00001234",
                "status": "PRS",
                "eta": "2023-05-01T10:00:00+00:00",
                "totalQuantity": 175,
                "shipFromAddress": {
                    "address": {
                        "organization": "ABC Distributors",
                        "addressLine1": "123 Main Street",
                        "addressLine2": "",
                        "country": "USA",
                        "state": "CA",
                        "city": "Los Angeles",
                        "postalCode": "90012",
                        "isResidential": false
                    },
                    "contact": {
                        "personName": "John Doe",
                        "phoneNumber": "123-456-7890",
                        "mobileNumber": "",
                        "faxNumber": "",
                        "emailAddress": "john.doe@abcdistributors.com"
                    }
                },
                "receiveLines": [
                    {
                        "sublines": [],
                        "lineNumber": "1",
                        "externalLineReference": "001",
                        "productCode": "APL-IPH-13PRO-256-GRPH",
                        "quantity": 100,
                        "quantityUnit": "UNT",
                        "lineAttributes": [],
                        "lineCustomAttributes": [],
                        "partAttributes": []
                    },
                    {
                        "sublines": [],
                        "lineNumber": "2",
                        "externalLineReference": "002",
                        "productCode": "SAM-GS22ULTRA-SILCASE-BLK",
                        "quantity": 50,
                        "quantityUnit": "UNT",
                        "lineAttributes": [],
                        "lineCustomAttributes": [],
                        "partAttributes": []
                    },
                    {
                        "sublines": [],
                        "lineNumber": "3",
                        "externalLineReference": "003",
                        "productCode": "HP-SPX360-14-OLED-I7-16GB-1TB-NFBLK",
                        "quantity": 25,
                        "quantityUnit": "UNT",
                        "lineAttributes": [],
                        "lineCustomAttributes": [],
                        "partAttributes": []
                    }
                ],
                "additionalReferences": [],
                "milestones": []
            }
        ]
    },
    "id": "f282ba6ca6ad435485f8cf0600ff0e61",
    "resource": [],
    "errors": []
}